home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / programr / wclass21.zip / README.TXT < prev    next >
Text File  |  1995-03-08  |  12KB  |  293 lines
  1. Welcome to With Class 2.1 Educational Version (10 Class Limit)
  2.  
  3. 1. Installing With Class
  4.  
  5. The following are the minimum system requirements for With Class:
  6. - 80386 processor or higher (80486 or higher recommended)
  7. - MS-Windows 3.1 or higher
  8. - Mouse that supports MS-Windows
  9. - VGA monitor - 1024x768 or higher resolution recommended
  10.  
  11. To initially install and run With Class, follow these steps:
  12.  
  13. >> Copy all With Class files into a directory, e.g. wc2
  14.  
  15. >> Copy MFCOLEUI.DLL into C:\WINDOWS\SYSTEM
  16.  
  17. >> Copy DATADIC1.DOT to the WINWORD\TEMPLATE directory if
  18. Microsoft Word 6.0 is present
  19.  
  20. >> Ensure CTL3D.DLL in your path, e.g. C:\WINDOWS\SYSTEM is in 
  21. your autoexec.bat path statement
  22.  
  23. >> Ensure the following files are in the C:\WINDOWS\SYSTEM 
  24. directory: COMPOBJ.DLL, STORAGE.DLL, OLE2.DLL, OLE2DISP.DLL, 
  25. OLE2NLS.DLL, CTL3D.DLL, AND MFCOLEUI.DLL.  If not installed,
  26. copy the provided dll's into C:\WINDOWS\SYSTEM. Note - do
  27. not overwrite any installed dll's unless you have a problem.
  28. A early wc2 release contained OLE2 dll's dated 11/16/94 which 
  29. caused some problems with Microsoft Office applications.  
  30. Specifically, you could not run Microsoft Chart from Microsoft 
  31. Word 6.0. This release contains the OLE2 dll's dated 11/20/94 
  32. which work well with Microsoft Office applications.
  33.  
  34. >> Ensure SHARE is either executed automatically or is in your
  35. autoexec.bat.  Sample entries are C:\DOS\SHARE, 
  36. C:\DOS\SHARE /L:500, OR C:\DOS\SHARE /F:5100 /L:500.  
  37. Alternatively, a sample config.sys entry is INSTALL=SHARE /F:4096.
  38.  
  39. >> In Windows Program Manager, create the With Class icon by 
  40. selecting "File New", "Program Icon", and entering WC2.EXE
  41.  
  42. >> In Windows, run With Class from Windows, e.g. "File Run 
  43. WC2.EXE" or double click the With Class icon
  44.  
  45. To  install With Class from a disk provided from MicroGold:  
  46. Type from windows program manager  FILE | RUN a:install.exe.
  47. To print user instructions, print topics from the Help Menu.
  48.  
  49. With Class file creates wc2.ini in the windows directory.  If you 
  50. have problems launching With Class, delete WC2.INI so that it is 
  51. automatically regenerated.  If you have video problems, try using
  52. standard VGA (640 x 480) or the most up-to-date video drivers 
  53. available for your video card.  Ensure you are using the dll's
  54. provided with the product.  Older version dll's may be on your
  55. system in another directory and may be invoked.  If you have any 
  56. installation problems, contact MicroGold Software at 
  57. 71543.1172@compuserve.com.
  58.  
  59. Known Limitations with this educational version : 
  60. (1) Due to OLE constraints only 3 diagrams may be open at a time.  
  61. When you try to save the 4th diagram, you may get an error, e.g. 
  62. Illegal File Name.  If you get this error, close one or more 
  63. diagrams and save the diagram.  
  64. (2) Once an OLE object is inserted into a diagram using Insert 
  65. New Object, it cannot be deleted. 
  66. (3) OLE Copy is experimental and may cause unpredictable results 
  67. if you use Copy OLE menu command to copy, paste, and activate a 
  68. diagram into MS Word 6.0. To copy a diagram into another Windows 
  69. application, it is recommended that you use Copy for a bitmap copy. 
  70. (4) Cut is not implemented.
  71. (5) Put only 9 classes on a diagram.  Putting 10 or more classes 
  72. on this educational version may cause unpredicable results.
  73.  
  74. 2.  Primary Files in this release
  75. - readme.txt    Installation Instructions
  76. - wc2.exe       With Class Program
  77. - wc2.hlp       With Class Help Program
  78. - *.dll         DLL's used by With Class Program
  79. - wc2tutor.wri  O-O Modeling Using With Class
  80. - codegen.wri   Instructions on Generating Code Using Scripts
  81. - *.sct         Text Script Files for custom reports and code
  82.         generation
  83. - *.omt         Class diagrams to test code generation scripts
  84. - datadic1.dot  Microsoft Word 6.0 document template for 
  85.         a data dictionary
  86.  
  87. 3.  Using With Class Scripts
  88.  
  89. >> Launch With Class from Windows
  90. >> Open a class diagram, e.g. cppcar.omt
  91. >> Select "Generate - Generate Report"
  92. >> Enter a report name, e.g. REPORT.TXT
  93. >> Select RPTALL.SCT to generate the report
  94. >> Select "File - Edit File" and open REPORT.TXT
  95.  
  96. Here is a list of all the script variables that may be used to create
  97. custom reports and code generation.
  98.  
  99. CLASS_NAME or CLASS
  100. CLASS_CARDINALITY
  101. CLASS_CONCURRENCY
  102. CLASS_PERSISTENCE
  103. CLASS_ACCESS
  104. CLASS_FILENAME
  105. CLASS_AUTHOR_INITIALS
  106. CLASS_LIBRARY_BASE_CLASS
  107. CLASS_INVARIANT
  108. CLASS_DESCRIPTION
  109. INCLUDE_FILE
  110.  
  111. ATTRIBUTE_NAME
  112. ATTRIBUTE_TYPE
  113. ATTRIBUTE_ACCESS
  114. ATTRIBUTE_MAX_VALUE
  115. ATTRIBUTE_MIN_VALUE
  116. ATTRIBUTE_CONSTRAINT
  117. ATTRIBUTE_INITIAL_VALUE
  118. ATTRIBUTE_INFO
  119.  
  120. OPERATION_NAME
  121. OPERATION_RETURN_TYPE
  122. CPP_OPERATION_PARAMETERS
  123. OPERATION_ACCESS
  124. OPERATION_TRANSFORMATION
  125. OPERATION_PRECONDITION
  126. OPERATION_POSTCONDITION
  127. OPERATION_EXCEPTION_TYPE
  128. OPERATION_EXCEPTION_NAME
  129. OPERATION_CLASSIFICATION
  130. OPERATION_CONCURRENCY
  131. OPERATION_CODE
  132. OPERATION_COMMENT1
  133. OPERATION_COMMENT2
  134. OPERATION_COMMENT3
  135.  
  136. ASSOCIATION_CLASS
  137. ASSOCIATION_NAME
  138. AGGREGATION_CLASS
  139. AGGREGATION_NAME
  140.  
  141. ASSOCIATION_ONE_CLASS
  142. ASSOCIATION_ONE_NAME
  143. AGGREGATION_ONE_CLASS
  144. AGGREGATION_ONE_NAME
  145. ASSOCIATION_MANY_CLASS
  146. ASSOCIATION_MANY_NAME
  147. AGGREGATION_MANY_CLASS
  148. AGGREGATION_MANY_NAME
  149. BASE_CLASS
  150.  
  151. CPP_OPERATIONS
  152. CPP_OPERATION_VIRTUAL
  153. CPP_OPERATION_PURE_VIRTUAL
  154. CPP_OPERATION_CONSTANT
  155. CPP_OPERATION_STATIC
  156. CPP_ATTRIBUTES
  157. CPP_BASE_CLASSES
  158. CPP_AGGREGATIONS
  159. CPP_ASSOCIATIONS
  160.  
  161. PASCAL_OPERATION_PARAMETERS
  162. PASCAL_OPERATION_PARAMETERS_PAREN
  163. PASCAL_OPERATION_PARAMETERS_WITH_VAR
  164. PASCAL_OPERATION_RETURN_TYPE
  165. PASCAL_OPERATION_VIRTUAL
  166. ADA_OPERATION_PARAMETERS
  167. SMALLTALK_OPERATION_PARAMETERS
  168. ACTOR_OPERATION_PARAMETERS
  169. CLASS_PERSISTENT - prints persistent
  170.  
  171. LITERAL_SYMBOL
  172. NO_RETURN
  173. NO_REPEAT
  174. DELETE_LAST_SYMBOL
  175. TRUNCATE_EIGHT
  176.  
  177. [ ]   // anything placed in between these will be repeated for every
  178.      // attribute, operation, constant, etc. 
  179.  
  180. $  // use this to separate out keywords (above) from text that you
  181.     wish to run in juxtaposition. 
  182.  
  183. 4. Creating a Data Dictionary in Microsoft Word 6.0
  184. You can create a text data dictionary by running the script rptdict.sct.
  185. However, it is recommended that you create your data dictionary in
  186. Microsoft Word 6.0 to be able to sort and set fonts.
  187. To create a data dictionary in Microsoft Word 6.0 follow these steps:
  188.  
  189. >> Copy the Microsoft Word 6.0 template datadic1.dot into the 
  190.    Winword\template directory
  191.  
  192. >> Launch With Class from Windows
  193. >> Open a class diagram, e.g. cppcar.omt
  194. >> Select "Generate - Generate Report"
  195. >> Enter a report name, e.g. datadict.txt
  196. >> Select worddic1.sct to generate the text version of the data dictionary
  197.  
  198. >> Launch Microsoft Word 6.0
  199. >> Select "File - New" and Template datadic1 (datadic1.dot)
  200. >> Select "Insert - Database"
  201. >> Place cursor below the headings
  202. >> Select "Get Data" and Text Files (*.txt) and datadict.txt (generated 
  203.    data dictionary text file)
  204. >> Select "Insert Data" and All to import the data dictionary entries.
  205. >> Delete blank rows, set font sizes, sort as desired.
  206.  
  207. 5. This version supports entering and saving data types from various 
  208. languages.  Data types are saved in the wc2.ini file.  WC2.ini is created
  209. upon installation and if no wc2.ini exists.  The initial wc2.ini has C/C++ 
  210. data types, e.g. int, float.  Whenever you enter a new data type for an 
  211. attribute, the wc2.ini file is updated.  When you begin using With Class,
  212. it is recommended that you create a diagram to enter the all the basic 
  213. data types for attributes for the language and class library that you
  214. are using.  The following are sample data types that may be used in various
  215. languages:
  216. - Microsoft Visual C++: CString    needs #includes "stdafx.h" or <afx.h>
  217. - Borland C++ 3.X: String          needs #include <strng.h>
  218. - Borland C++ 4.X: string          needs #include <string.h>
  219. - Pascal and Delphi: Byte, Integer, LongInt, Word, Real, char, String, Double
  220. - Ada: Boolean, Character, Integer, Float, Positive, Natural, Duration, String
  221. - Eiffel: BOOLEAN, CHARACTER, INTEGER, REAL, DOUBLE, ARRAY, STRING
  222. You may directly update the wc2.ini file to change a spelling or capitalization.
  223. If you modify the wc2.ini file ensure that Number = the number of types.
  224. Close With Class prior to making changes to wc2.ini
  225. If your wc2.ini file becomes corrupted, delete or rename wc2.ini and a new
  226. wc2.ini will be regenerated the next time you start With Class.   
  227.  
  228. 6.To receive e-mail newsletters and announcements, please send your e-mail
  229. address to Michael Gold, MicroGold Software at 
  230.     Internet 71543.1172@compuserve.com or 
  231.     CompuServe 71543,1172. 
  232. We will periodically send out newsletters, announcements, and new scripts.  
  233. Also, please send in the e-mail address of anyone who is interested in 
  234. object-oriented CASE tools.
  235. Also, for technical questions please e-mail questions to the above address.
  236. Periodically, MicroGold uploads demo and shareware tools to the Internet.  
  237. Currently the educational shareware version (10 class limit) of With Class 
  238. 2.0 is at the following FTP sites: 
  239. oak.oakland.edu/SimTel/win3/pgmtools/wclass21.zip and cica.indiana.edu.  
  240. On CompuServe wclass.zip is in MSMFC/DOC/VIEW/UI, 
  241. CASE/CASE, and WINSHARE/PROGRAMMING.  On CompuServe type GO IBMFF and enter 
  242. wclass.zip to find the latest version of the shareware With Class.
  243.  
  244. The demo version of StateMaker (no save) is at the following FTP site: 
  245. oak.oakland.edu/SimTel/win3/pgmtools/state31.zip.
  246.  
  247. 7. Training and Consulting Services using With Class
  248. RCF Associates offers custom training and consulting services using
  249. With Class with object-oriented design projects with object-
  250. oriented languages.  The following services and products are
  251. offered.
  252.  
  253. - Custom model development (drawings and specifications) for 
  254. a system based upon your requirements statement and block diagram.
  255.  
  256. - Executable prototype for a system in C++, Eiffel, Ada,
  257. and other languages based upon your model (diagrams and specifications).
  258.  
  259. - Custom With Class scripts for reports and code generation for your
  260. specific language, class library, and coding standards.
  261.  
  262. - On-site training course "Object-Oriented Modeling with CASE and 
  263. C++".  Course is one to five days customized to your requirements
  264. including modeling your system during the course.
  265.  
  266. - "Object-Oriented Modeling with CASE and C++"  training manual
  267. (200 pages) and training course viewgraph masters (400 pages)
  268. both with 4 complete "charter to C++" case studies.
  269.  
  270. - VHS Training Videos on Object-Oriented Modeling and Using
  271. With Class and StateMaker.
  272.  
  273. Customer satisfaction is guaranteed.  For information contact 
  274. Richard Felsinger, RCF Associates, 960 Scottland Dr, Mt Pleasant,
  275. SC 29464 803-881-3648 e-mail 71162.755@compuserve.com 
  276.  
  277. 8. All users are encouraged to register this shareware for $59.00
  278. at 1-908-722-6438 after 30 days.  Users may order the With Class 
  279. Professional Version with unlimited number of classes and laser 
  280. printed user documentation for $149.00 plus $10.00 shipping and 
  281. handling ($20.00 shipping and handling for orders outside the US.) 
  282. Each With Class Profession comes with the StateMaker CASE 
  283. tool for creating state transition diagrams and generating C/C++ 
  284. code from the diagrams.  StateMaker without With Class Professional
  285. is $99.00 plus $5.00 shipping and handling.
  286.  
  287. Thank you for trying With Class.
  288. Michael Gold, MicroGold Software,
  289. 696 Birch Hill Drive, Bridgewater, NJ 08807 
  290. Telephone 1-908-722-6438 e-mail 71543,1172@compuserve.com
  291.  
  292.  
  293.